feat(server): Implement and document security group attach/detach commands by s-inter · Pull Request #1341 · stackitcloud/stackit-cli

s-inter · 2026-03-13T09:38:52Z

Description

This PR implements the stackit server security-group attach and detach commands.

Changes

Added stackit server security-group attach to associate a security group with a server.
Added stackit server security-group detach to remove a security group from a server.
Added unit tests for input parsing and request building.
Generated updated command documentation.

Testing Instructions

Preconditions: have an existing server and a security group in the same project/region.
Build:

make build

Attach:

./bin/stackit server security-group attach --server-id <SERVER_ID> --security-group-id <SG_ID>

Verify attach via server describe:

./bin/stackit server describe <SERVER_ID> --output-format json | jq '[.nics[].securityGroups[]]'

Confirm the security group appears in the server details.

Detach:

./bin/stackit server security-group detach --server-id <SERVER_ID> --security-group-id <SG_ID>

Verify detach via server describe and confirm the security group is no longer associated.

Related Issues

Resolves #1216

relates to STACKITCLI-308

Checklist

Issue was linked above
Code format was applied: make fmt
Examples were added / adjusted (see e.g. here)
Docs are up-to-date: make generate-docs (will be checked by CI)
Unit tests got implemented or updated
Unit tests are passing: make test (will be checked by CI)
No linter issues: make lint (will be checked by CI)

…nal arguments

…unction to ignore unused input arguments

…commands

github-actions · 2026-03-13T09:42:43Z

Merging this branch will increase overall coverage

Impacted Packages	Coverage Δ	🤖
github.com/stackitcloud/stackit-cli/internal/cmd/server	0.00% (ø)
github.com/stackitcloud/stackit-cli/internal/cmd/server/security-group	0.00% (ø)
github.com/stackitcloud/stackit-cli/internal/cmd/server/security-group/attach	36.59% (+36.59%)	🌟
github.com/stackitcloud/stackit-cli/internal/cmd/server/security-group/detach	36.59% (+36.59%)	🌟
github.com/stackitcloud/stackit-cli/internal/cmd/server/service-account/detach	45.00% (ø)

Coverage by file

Changed files (no unit tests)

Changed File	Coverage Δ	Total	Covered	Missed	🤖
github.com/stackitcloud/stackit-cli/internal/cmd/server/security-group/attach/attach.go	36.59% (+36.59%)	41 (+41)	15 (+15)	26 (+26)	🌟
github.com/stackitcloud/stackit-cli/internal/cmd/server/security-group/detach/detach.go	36.59% (+36.59%)	41 (+41)	15 (+15)	26 (+26)	🌟
github.com/stackitcloud/stackit-cli/internal/cmd/server/security-group/security-group.go	0.00% (ø)	5 (+5)	0	5 (+5)
github.com/stackitcloud/stackit-cli/internal/cmd/server/server.go	0.00% (ø)	26 (+1)	0	26 (+1)
github.com/stackitcloud/stackit-cli/internal/cmd/server/service-account/detach/detach.go	45.00% (ø)	40	18	22

Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code.

Changed unit test files

github.com/stackitcloud/stackit-cli/internal/cmd/server/security-group/attach/attach_test.go
github.com/stackitcloud/stackit-cli/internal/cmd/server/security-group/detach/detach_test.go

s-inter · 2026-03-13T09:43:52Z

internal/cmd/server/service-account/detach/detach.go

 			}

-			prompt := fmt.Sprintf("Are your sure you want to detach service account %q from a server %q?", model.ServiceAccMail, serverLabel)
+			prompt := fmt.Sprintf("Are you sure you want to detach service account %q from a server %q?", model.ServiceAccMail, serverLabel)


Typo fix (boyscout) - okay to keep in here?

totally fine, thanks

rubenhoenle · 2026-03-16T09:19:10Z

internal/cmd/server/security-group/attach/attach.go

+				return fmt.Errorf("attach security group to server: %w", err)
+			}
+
+			params.Printer.Info("Attached security group %q to server %q\n", securityGroupLabel, serverLabel)


Suggested change

params.Printer.Info("Attached security group %q to server %q\n", securityGroupLabel, serverLabel)

params.Printer.Outputf("Attached security group %q to server %q\n", securityGroupLabel, serverLabel)

This is often handled wrong in the codebase, that's why I'll explain it in detail. Please make sure to remember this in the future and especially look out for it in code reviews you will do in the future. 😅

Outputf prints to stdout, Info prints to stderr. See the code examples below for details.

Since this output here is a success message and no error message, it belongs into the stdout output from my perspective.

stackit-cli/internal/pkg/print/print.go

Lines 68 to 76 in 26bc5f1

// Print an output using Printf to the defined output (falling back to Stderr if not set).

// If output format is set to none, it does nothing

func (p *Printer) Outputf(msg string, args ...any) {

outputFormat := viper.GetString(outputFormatKey)

if outputFormat == NoneOutputFormat {

return

}

p.Cmd.Printf(msg, args...)

}

stackit-cli/internal/pkg/print/print.go

Lines 107 to 114 in 26bc5f1

// Print an Info level output to the defined Err output (falling back to Stderr if not set).

// If the verbosity level is not Debug or Info, it does nothing.

func (p *Printer) Info(msg string, args ...any) {

if !p.IsVerbosityDebug() && !p.IsVerbosityInfo() {

return

}

p.Cmd.PrintErrf(msg, args...)

}

rubenhoenle · 2026-03-16T09:23:44Z

internal/cmd/server/security-group/attach/attach_test.go

+
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			p := print.NewPrinter()


stackit-cli/internal/cmd/server/backup/schedule/list/list_test.go

Line 123 in 26bc5f1

testutils.TestParseInput(t, NewCmd, parseInput, tt.expectedModel, tt.argValues, tt.flagValues, tt.isValid)

stackit-cli/internal/pkg/testutils/testutils.go

Lines 14 to 26 in 26bc5f1

// TestParseInput centralizes the logic to test a combination of inputs (arguments, flags) for a cobra command

func TestParseInput[T any](t *testing.T, cmdFactory func(*types.CmdParams) *cobra.Command, parseInputFunc func(*print.Printer, *cobra.Command, []string) (T, error), expectedModel T, argValues []string, flagValues map[string]string, isValid bool) {

t.Helper()

TestParseInputWithAdditionalFlags(t, cmdFactory, parseInputFunc, expectedModel, argValues, flagValues, map[string][]string{}, isValid)

}

// TestParseInputWithAdditionalFlags centralizes the logic to test a combination of inputs (arguments, flags) for a cobra command.

// It allows to pass multiple instances of a single flag to the cobra command using the `additionalFlagValues` parameter.

func TestParseInputWithAdditionalFlags[T any](t *testing.T, cmdFactory func(*types.CmdParams) *cobra.Command, parseInputFunc func(*print.Printer, *cobra.Command, []string) (T, error), expectedModel T, argValues []string, flagValues map[string]string, additionalFlagValues map[string][]string, isValid bool) {

TestParseInputWithOptions(t, cmdFactory, parseInputFunc, expectedModel, argValues, flagValues, additionalFlagValues, isValid, nil)

}

func TestParseInputWithOptions[T any](t *testing.T, cmdFactory func(*types.CmdParams) *cobra.Command, parseInputFunc func(*print.Printer, *cobra.Command, []string) (T, error), expectedModel T, argValues []string, flagValues map[string]string, additionalFlagValues map[string][]string, isValid bool, testingOptions []TestingOption) {

Please use this util funcs to save us the boilerplate code

rubenhoenle · 2026-03-16T09:23:56Z

internal/cmd/server/security-group/detach/detach.go

+				return fmt.Errorf("detach security group from server: %w", err)
+			}
+
+			params.Printer.Info("Detached security group %q from server %q\n", securityGroupLabel, serverLabel)


rubenhoenle · 2026-03-16T09:24:05Z

internal/cmd/server/security-group/detach/detach_test.go

+
+	for _, tt := range tests {
+		t.Run(tt.description, func(t *testing.T) {
+			p := print.NewPrinter()


s-inter added 8 commits March 10, 2026 15:08

feat(server): create security-group attach and detach command scaffolds

5aa1caa

fix(server): fix typo

0b406a0

feat(server): implement attach security group command

c45dcbc

feat(server): implement detach security group command

879b341

feat(server): refactor attach command to use flags instead of positio…

8a32a6c

…nal arguments

feat(server): refactor detach command to use flags instead of positio…

57d004d

…nal arguments

fix(server): fix unused-parameter linter warning, update parseInput f…

902777c

…unction to ignore unused input arguments

feat(server): add documentation for security group attach and detach …

a107df6

…commands

s-inter commented Mar 13, 2026

View reviewed changes

s-inter linked an issue Mar 13, 2026 that may be closed by this pull request

IaaS: add security group to server not supported #1216

Open

rubenhoenle reviewed Mar 16, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(server): Implement and document security group attach/detach commands#1341

feat(server): Implement and document security group attach/detach commands#1341
s-inter wants to merge 8 commits intomainfrom
feat/server-security-group-attach-and-detach

s-inter commented Mar 13, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 13, 2026

Changed files (no unit tests)

Changed unit test files

Uh oh!

s-inter Mar 13, 2026

Uh oh!

rubenhoenle Mar 16, 2026

Uh oh!

rubenhoenle Mar 16, 2026

Uh oh!

rubenhoenle Mar 16, 2026

Uh oh!

rubenhoenle Mar 16, 2026

Uh oh!

rubenhoenle Mar 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	params.Printer.Info("Attached security group %q to server %q\n", securityGroupLabel, serverLabel)
	params.Printer.Outputf("Attached security group %q to server %q\n", securityGroupLabel, serverLabel)

	// Print an output using Printf to the defined output (falling back to Stderr if not set).
	// If output format is set to none, it does nothing
	func (p *Printer) Outputf(msg string, args ...any) {
	outputFormat := viper.GetString(outputFormatKey)
	if outputFormat == NoneOutputFormat {
	return
	}
	p.Cmd.Printf(msg, args...)
	}

	// Print an Info level output to the defined Err output (falling back to Stderr if not set).
	// If the verbosity level is not Debug or Info, it does nothing.
	func (p *Printer) Info(msg string, args ...any) {
	if !p.IsVerbosityDebug() && !p.IsVerbosityInfo() {
	return
	}
	p.Cmd.PrintErrf(msg, args...)
	}

	// TestParseInput centralizes the logic to test a combination of inputs (arguments, flags) for a cobra command
	func TestParseInput[T any](t testing.T, cmdFactory func(types.CmdParams) cobra.Command, parseInputFunc func(print.Printer, *cobra.Command, []string) (T, error), expectedModel T, argValues []string, flagValues map[string]string, isValid bool) {
	t.Helper()
	TestParseInputWithAdditionalFlags(t, cmdFactory, parseInputFunc, expectedModel, argValues, flagValues, map[string][]string{}, isValid)
	}

	// TestParseInputWithAdditionalFlags centralizes the logic to test a combination of inputs (arguments, flags) for a cobra command.
	// It allows to pass multiple instances of a single flag to the cobra command using the `additionalFlagValues` parameter.
	func TestParseInputWithAdditionalFlags[T any](t testing.T, cmdFactory func(types.CmdParams) cobra.Command, parseInputFunc func(print.Printer, *cobra.Command, []string) (T, error), expectedModel T, argValues []string, flagValues map[string]string, additionalFlagValues map[string][]string, isValid bool) {
	TestParseInputWithOptions(t, cmdFactory, parseInputFunc, expectedModel, argValues, flagValues, additionalFlagValues, isValid, nil)
	}

	func TestParseInputWithOptions[T any](t testing.T, cmdFactory func(types.CmdParams) cobra.Command, parseInputFunc func(print.Printer, *cobra.Command, []string) (T, error), expectedModel T, argValues []string, flagValues map[string]string, additionalFlagValues map[string][]string, isValid bool, testingOptions []TestingOption) {

Conversation

s-inter commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Testing Instructions

Related Issues

Checklist

Uh oh!

github-actions bot commented Mar 13, 2026

Merging this branch will increase overall coverage

Changed files (no unit tests)

Changed unit test files

Uh oh!

s-inter Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

rubenhoenle Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

rubenhoenle Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

rubenhoenle Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

rubenhoenle Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

rubenhoenle Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

s-inter commented Mar 13, 2026 •

edited

Loading